Skip to content

Add documentation for nested field translations #2791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 19, 2025
Merged

Add documentation for nested field translations #2791

merged 1 commit into from
Oct 19, 2025

Conversation

@cr7pt0gr4ph7
Copy link
Contributor

@cr7pt0gr4ph7 cr7pt0gr4ph7 commented Sep 10, 2025 •
edited
Loading

Proposed change

Add documentation for nested field translations (new feature).
See home-assistant/frontend#26997 and home-assistant/supervisor#6180 for context.

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features for which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Remove stale or deprecated documentation

Checklist

  • I have read and followed the documentation guidelines.
  • I have verified that my changes render correctly in the documentation.

Additional information

@cr7pt0gr4ph7 cr7pt0gr4ph7 mentioned this pull request Sep 10, 2025
Merged
14 tasks
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 10, 2025

📝 Walkthrough

Walkthrough

Added SSH configuration to the add-on schema with public_key and private_key fields, and introduced corresponding UI translations (name, description, field labels). Existing SSL documentation remains unchanged. No exported or public entity declarations were modified.

Changes

Cohort / File(s) Summary of changes
Docs: Add-on configuration schema and translations
docs/add-ons/configuration.md		 Inserted ssh option under Options/Schema with private_key: str and public_key: str. Added matching configuration translations (name, description, and field labels for public/private keys). Left existing ssl entry and note unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The current title "Add documentation for nested field translations" is concise, specific, and accurately reflects the PR's main change (adding documentation for nested field translations), making it clear to reviewers scanning history.
Description Check ✅ Passed The PR description follows the repository template and is mostly complete: the Proposed change is filled, the correct Type of change box is selected, Checklist items are checked, and Additional information includes related frontend and supervisor PR links; only minor omissions are the unresolved "fixes #" placeholder and absence of direct code file links, which are non-critical for this documentation PR.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot reviewed Sep 10, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/add-ons/configuration.md (1)

303-313: Tighten field descriptions to set expected formats.

Clarify formats to reduce user error and align with common SSH key types.

   ssh:
     name: SSH Options
-    description: Configure SSH authentication options
+    description: Configure SSH authentication options
     fields:
       public_key:
         name: Public Key
-        description: Client Public Key
+        description: OpenSSH public key (e.g., ssh-ed25519, ecdsa, rsa)
       private_key:
         name: Private Key
-        description: Client Private Key
+        description: PEM-encoded private key (will be hidden in UI)

Confirm the frontend renders nested field translations as shown for objects (key: ssh with subfields) per home-assistant/frontend#26997.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 119d4df and 6aa20fa.

📒 Files selected for processing (1)
  • docs/add-ons/configuration.md (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - developers-home-assistant
  • GitHub Check: Header rules - developers-home-assistant
  • GitHub Check: Pages changed - developers-home-assistant

@cr7pt0gr4ph7
Copy link
Contributor Author

cr7pt0gr4ph7 commented Sep 10, 2025 •
edited
Loading

I'm ignoring the AI code review comments, because it thinks this PR is actually about SSH keys...

@frenck frenck merged commit 99cc968 into home-assistant:master Oct 19, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@agners agners agners approved these changes

Assignees

No one assigned

Labels

has-parent

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@cr7pt0gr4ph7 @agners @frenck @silamon